package edu.ptu.shortlink.admin.service;

import com.baomidou.mybatisplus.extension.service.IService;
import edu.ptu.shortlink.admin.dao.entity.UserDO;
import edu.ptu.shortlink.admin.dto.req.UserLoginReqDTO;
import edu.ptu.shortlink.admin.dto.req.UserRegisterReqDTO;
import edu.ptu.shortlink.admin.dto.req.UserUpdateReqDTO;
import edu.ptu.shortlink.admin.dto.resp.UserLoginRespDTO;
import edu.ptu.shortlink.admin.dto.resp.UserRespDTO;

/**
 * @BelongsProject: shortlink
 * @BelongsPackage: edu.ptu.shortlink.admin.service
 * @Author: HYJ
 * @CreateTime: 2025-04-22  21:06
 * @Description: 用户接口层
 * @Version: 1.0
 */
public interface IUserService extends IService<UserDO> {
    /**
     * 根据用户名查询用户
     *
     * @param username 用户名
     * @return 用户返回实体
     */
    UserRespDTO getUserByUserName(String username);

    /**
     * 查询用户是否k可用
     *
     * @param username 用户名
     * @return 用户名是否可用 true 可用 false 不可用
     */
    Boolean availableUsername(String username);

    /**
     * 注册用户
     *
     * @param requestParam 注册请求实体
     */
    void register(UserRegisterReqDTO requestParam);


    /**
     * 根据用户名修改用户
     *
     * @param requestParam 修改用户请求参数
     */
    void update(UserUpdateReqDTO requestParam);


    /**
     * 用户登录
     *
     * @param requestParam 用户请求实体
     * @return UserLoginRespDTO 用户响应实体
     */
    UserLoginRespDTO login(UserLoginReqDTO requestParam);

    /**
     * 检查用户是否登录
     *
     * @param username 用户名
     * @param token    用户登录token
     * @return 用户是否登录bool
     */
    Boolean checkLogin(String username, String token);

    /**
     * 用户退出登录
     *
     * @param username 用户名
     * @param token    用户token
     */
    void logout(String username, String token);
}
